SetEOF

SetEOF
Header:	Files.h		Carbon status:	Supported

Sets the logical end-of-file of an open file.

OSErr SetEOF (
    SInt16 refNum, 
    SInt32 logEOF
);

refNum: The file reference number of an open file.
logEOF: The logical end-of-file. If you set the logEOF parameter to 0, all space occupied by the file on the volume is released. The file still exists, but it contains 0 bytes. Setting a file fork’s end-of-file to 0 is therefore not the same as deleting the file (which removes both file forks at once).

function result: A result code.

DISCUSSION

If you attempt to set the logical end-of-file beyond the physical end-of-file, the physical end-of-file is set 1 byte beyond the end of the next free allocation block; if there isn’t enough space on the volume, no change is made, and SetEOF returns dskFulErr as its function result.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.